Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: docsting for call() in BaseGoogle LLM #577

Merged

Conversation

nautics889
Copy link
Contributor

@nautics889 nautics889 commented Sep 19, 2023

An agrument called value seems to be deprecated in current version for Google LLMs classes (it was added in baedcbc). Remove the docsting.
Update docstrings for instruction (too general type object was specified, this mismatches type hints).
Update docstrings for suffix.


  • (docs): remove an argument description deprecated for the deprecated value argument
  • (docs): change type for instruction
  • (docs): make suffix description to look more verbose

Summary by CodeRabbit

  • Refactor: Updated the call method in the base class of the pandasai/llm/base.py file. The changes include removal of the value parameter and modification of the suffix parameter's default value. Additionally, the instruction parameter has been annotated with the type Prompt. These changes streamline the function signature and enhance code readability without altering the core functionality.

* (docs): remove an argument description deprecated for the deprecated
  `value` argument
* (docs): change type for `instruction`
* (docs): make `suffix` description to look more verbose
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 19, 2023

Walkthrough

The changes primarily revolve around the call method in a class within the base.py file. The modifications include removal of the value parameter, adjustment of the suffix parameter's default value, and type annotation for the instruction parameter.

Changes

File Summary
pandasai/llm/base.py The call method has been updated: value parameter removed, suffix parameter's default value adjusted, and instruction parameter now has a Prompt type annotation.

🐇💻

In the realm where code rabbits play,
A change was made, hip hip hooray!
No more 'value', it's gone away,
'Suffix' stands alone today.
'Instruction' now wears a new hat,
A 'Prompt' type, just like that!
So let's hop on, no time to chat,
Celebrate the code, tit for tat! 🎉🥕


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 9d55463 and c5b5d80.
Files selected for processing (1)
  • pandasai/llm/base.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • pandasai/llm/base.py

@codecov-commenter
Copy link

Codecov Report

Merging #577 (c5b5d80) into main (0eca724) will decrease coverage by 0.21%.
Report is 15 commits behind head on main.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main     #577      +/-   ##
==========================================
- Coverage   83.42%   83.22%   -0.21%     
==========================================
  Files          52       54       +2     
  Lines        2594     2682      +88     
==========================================
+ Hits         2164     2232      +68     
- Misses        430      450      +20     
Files Changed Coverage Δ
pandasai/llm/base.py 88.97% <ø> (-1.03%) ⬇️

... and 12 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@gventuri gventuri merged commit 7738feb into Sinaptik-AI:main Sep 20, 2023
9 checks passed
gventuri pushed a commit that referenced this pull request Sep 25, 2023
* (docs): remove an argument description deprecated for the deprecated
  `value` argument
* (docs): change type for `instruction`
* (docs): make `suffix` description to look more verbose
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants